OTA-1174: upgrade status: Expand health insights with --detailed=health - #1736

In response to this:

--details=health shows reference and description

Every insight will have two more fields:

• description: human-oriented, potentially longer form message that should explain what is going on and should indicate a direction for fixing the problem
• remediation URL: link to a helpful runbook or documentation location

In detailed mode the output is arranged not in a table, but as a oc describe-like tree.

---

populate descriptions and refs for insights

Descriptions were populated with message strings coming from respective sources: either a ClusterOperator condition or MCO annotation.

References were populated with existing runbooks for matching ClusterOperator alerts, or with links to existing MCO documentation for the given domain.

---

pad linebreaks in descriptions

Descriptions (with linebreaks) are no longer shown in tabular output, just in detailed tree one. Hence, we may keep them, but should pad them respectively so the blocks of text are properly indented.

---

ignore incomplete insights

Incomplete insights are not not actionable enough to show them to the user, so we filter them out while processing.

---

always tabulate 'All is well'

"All is well" is an artificial insight so that we can show something when everything goes fine. There is no point in showing details for it because all detailed fields are empty.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

In response to this:

Review notes: Please focus on the structure, not on the actual content of the expaned insights. Insights are data, we can easily improve them. Especially the content of the node-related insights can be improved (and generating single insight per node is probably overwhelming) and #1690 goes further in that direction, but this PR concerns mostly about the new --detailed=health formatting, not with existing insight content.

---

--details=health shows reference and description

Every insight will have two more fields:

• description: human-oriented, potentially longer form message that should explain what is going on and should indicate a direction for fixing the problem
• remediation URL: link to a helpful runbook or documentation location

In detailed mode the output is arranged not in a table, but as a oc describe-like tree.

---

populate descriptions and refs for insights

Descriptions were populated with message strings coming from respective sources: either a ClusterOperator condition or MCO annotation.

References were populated with existing runbooks for matching ClusterOperator alerts, or with links to existing MCO documentation for the given domain.

---

pad linebreaks in descriptions

Descriptions (with linebreaks) are no longer shown in tabular output, just in detailed tree one. Hence, we may keep them, but should pad them respectively so the blocks of text are properly indented.

---

ignore incomplete insights

Incomplete insights are not not actionable enough to show them to the user, so we filter them out while processing.

---

always tabulate 'All is well'

"All is well" is an artificial insight so that we can show something when everything goes fine. There is no point in showing details for it because all detailed fields are empty.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

In response to this:

Review notes:

Please focus on the structure, not on the actual content of the expaned insights. Insights are data, we can easily improve them. Especially the content of the node-related insights can be improved (and generating single insight per node is probably overwhelming) and #1690 goes further in that direction, but this PR concerns mostly about the new --detailed=health formatting, not with existing insight content.

Some smaller changes are separated into small commits, I recommend reviewing by commit.

---

--details=health shows reference and description

Every insight will have two more fields:

• description: human-oriented, potentially longer form message that should explain what is going on and should indicate a direction for fixing the problem
• remediation URL: link to a helpful runbook or documentation location

In detailed mode the output is arranged not in a table, but as a oc describe-like tree.

---

populate descriptions and refs for insights

Descriptions were populated with message strings coming from respective sources: either a ClusterOperator condition or MCO annotation.

References were populated with existing runbooks for matching ClusterOperator alerts, or with links to existing MCO documentation for the given domain.

---

pad linebreaks in descriptions

Descriptions (with linebreaks) are no longer shown in tabular output, just in detailed tree one. Hence, we may keep them, but should pad them respectively so the blocks of text are properly indented.

---

ignore incomplete insights

Incomplete insights are not not actionable enough to show them to the user, so we filter them out while processing.

---

always tabulate 'All is well'

"All is well" is an artificial insight so that we can show something when everything goes fine. There is no point in showing details for it because all detailed fields are empty.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

• pkg/cli/admin/upgrade/OWNERS [petr-muller,wking]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.